home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / DTMLMETHOD.PY < prev    next >
Encoding:
Text File  |  2000-10-31  |  8.1 KB  |  203 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. def manage_addDTMLMethod(id, title):
  87.     """
  88.     Add a DTML Method to the current ObjectManager
  89.     """
  90.  
  91. class DTMLMethod:
  92.     """
  93.     A DTML Method is a Zope object that contains and executes DTML
  94.     code. It can act as a template to display other objects. It can
  95.     also hold small pieces of content which are inserted into other
  96.     DTML Documents or DTML Methods.
  97.  
  98.     The DTML Method's id is available via the 'document_id'
  99.     variable and the title is available via the 'document_title'
  100.     variable.
  101.     
  102.     """
  103.  
  104.     __extends__=('OFSP.ObjectManagerItem.ObjectManagerItem',)
  105.     
  106.     def __call__(client=None, REQUEST={}, **kw):
  107.         """
  108.  
  109.         Calling a DTMLMethod causes the Method to interpret the DTML
  110.         code that it contains.  The method returns the result of the
  111.         interpretation, which can be any kind of object.
  112.  
  113.         To accomplish its task, DTML Method often needs to resolve various
  114.         names into objects.  For example, when the code '<dtml-var
  115.         spam>' is executed, the DTML engine tries to resolve the name
  116.         'spam'.
  117.  
  118.         In order to resolve names, the Method must be passed a
  119.         namespace to look them up in.  This can be done several ways:
  120.  
  121.           * By passing a 'client' object -- If the argument 'client' is
  122.             passed, then names are looked up as attributes on the
  123.             argument.
  124.  
  125.           * By passing a 'REQUEST' mapping -- If the argument 'REQUEST'
  126.             is passed, then names are looked up as items on the
  127.             argument.  If the object is not a mapping, an TypeError
  128.             will be raised when a name lookup is attempted.
  129.  
  130.           * By passing keyword arguments -- names and their values can
  131.             be passed as keyword arguments to the Method.
  132.  
  133.         The namespace given to a DTML Method is the composite of
  134.         these three methods.  You can pass any number of them or none
  135.         at all. Names will be looked up first in the keyword argument,
  136.         next in the client and finally in the mapping.
  137.  
  138.         Unlike DTMLDocuments, DTMLMethods do not look up names in
  139.         their own instance dictionary.
  140.  
  141.         Passing in a namespace to a DTML Method is often referred to
  142.         as providing the Method with a *context*.
  143.  
  144.         DTML Methods are called three ways:
  145.  
  146.           From DTML -- A DTML Method can be called from another DTML
  147.             Method or Document::
  148.  
  149.               <dtml-var standard_html_header>
  150.                 <dtml-var aDTMLMethod>
  151.               <dtml-var standard_html_footer>
  152.  
  153.             In this example, the Method 'aDTMLMethod' is being called
  154.             from another DTML object by name.  The calling method
  155.             passes the value 'this' as the client argument and the
  156.             current DTML names pace as the REQUEST argument.  The above
  157.             is identical to this following usage in a DTML Python
  158.             expression::
  159.  
  160.               <dtml-var standard_html_header>
  161.                 <dtml-var "aDTMLMethod(_.None, _)">
  162.               <dtml-var standard_html_footer>
  163.  
  164.           From Python -- Products, External Methods, and PythonMethods 
  165.             can call a DTML Method in the same way as calling a DTML
  166.             Method from a Python expression in DTML; as shown in the
  167.             previous example.
  168.  
  169.           By the Publisher -- When the URL of a DTML Method is fetched 
  170.             from Zope, the DTML Method is called by the publisher.
  171.             The REQUEST object is passes as the second argument to the 
  172.             Method.
  173.           
  174.         Permission -- 'View'
  175.         """
  176.  
  177.     def manage_edit(data, title):
  178.         """
  179.         Change the DTML Method, replacing its contents with 'data' and
  180.         changing its title.
  181.         
  182.         The data argument may be a file object or a string.
  183.         
  184.         Permission -- 'Change DTML Methods'
  185.         """
  186.         
  187.     def document_src():
  188.         """
  189.         Returns the unrendered source text of the DTML Method.
  190.         
  191.         Permission -- 'View management screens'
  192.         """
  193.         
  194.     def get_size():
  195.         """
  196.         Returns the size of the unrendered source text of the DTML
  197.         Method in bytes.
  198.  
  199.         Permission -- 'View'
  200.         """
  201.         
  202.     __constructor__ = manage_addDTMLMethod
  203.